git2-rs
libgit2 bindings for Rust
[]
= "0.7"
Version of libgit2
Currently this library requires libgit2 0.25.1. The source for libgit2 is included in the libgit2-sys crate so there's no need to pre-install the libgit2 library, the libgit2-sys crate will figure that and/or build that for you.
Building git2-rs
First, you'll need to install CMake. Afterwards, just run:
Automating Testing
Running tests and handling all of the associated edge cases on every commit
proves tedious very quickly. To automate tests and handle proper stashing and
unstashing of unstaged changes and thus avoid nasty surprises, use the
pre-commit hook found here and place it into the
.git/hooks/
with the name pre-commit
. You may need to add execution
permissions with chmod +x
.
To skip tests on a simple commit or doc-fixes, use git commit --no-verify
.
Building on OSX 10.10+
Currently libssh2 requires linking against OpenSSL, and to compile libssh2 it also needs to find the OpenSSL headers. On OSX 10.10+ the OpenSSL headers have been removed, but if you're using Homebrew you can install them via:
License
This project is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in git2-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.